Skip to content

DOC: Continue to fix some simple broken ref across package #9777

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 8 commits into from
Aug 29, 2025
Merged

DOC: Continue to fix some simple broken ref across package #9777

merged 8 commits into from
Aug 29, 2025

Conversation

@pllim
Copy link
Collaborator

@pllim pllim commented Aug 27, 2025 •
edited by melanieclarke
Loading

This PR addresses a little bit of #9383 , as seen in #9666 .

This round touches a lot of subpackages because I tried to do global search and replace for common offenders. Hopefully the diff is self-explanatory.

No need to run RT.

Tasks

  • If you have a specific reviewer in mind, tag them.
  • add a build milestone, i.e. Build 12.0 (use the latest build if not sure)
  • Does this PR change user-facing code / API? (if not, label with no-changelog-entry-needed)
    • write news fragment(s) in changes/: echo "changed something" > changes/<PR#>.<changetype>.rst (see changelog readme for instructions)
    • update or add relevant tests
    • update relevant docstrings and / or docs/ page
    • start a regression test and include a link to the running job (click here for instructions)
      • Do truth files need to be updated ("okified")?
        • after the reviewer has approved these changes, run okify_regtests to update the truth files
  • if a JIRA ticket exists, make sure it is resolved properly

@codecov
Copy link

codecov bot commented Aug 27, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.49%. Comparing base (58cc165) to head (d1c362b).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #9777   +/-   ##
=======================================
  Coverage   82.49%   82.49%           
=======================================
  Files         366      366           
  Lines       37134    37139    +5     
=======================================
+ Hits        30633    30639    +6     
+ Misses       6501     6500    -1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@pllim pllim marked this pull request as ready for review August 27, 2025 17:26
@pllim pllim requested review from a team as code owners August 27, 2025 17:26
@pllim pllim requested a review from melanieclarke August 27, 2025 17:26
zacharyburnett
zacharyburnett reviewed Aug 27, 2025
View reviewed changes
@melanieclarke melanieclarke added this to the Build 12.1 milestone Aug 28, 2025
melanieclarke
melanieclarke reviewed Aug 28, 2025
View reviewed changes
Copy link
Collaborator

@melanieclarke melanieclarke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks generally reasonable! I have a few small clean up suggestions.

@pllim
Copy link
Collaborator Author

pllim commented Aug 28, 2025

Thanks for the detailed review and catching my mistakes, @melanieclarke ! Hopefully I have addressed them all. Please let me know if I miss anything.

melanieclarke
melanieclarke reviewed Aug 29, 2025
View reviewed changes
pllim and others added 7 commits August 29, 2025 14:19
@pllim
DOC: Fix broken ref
0d81639 
by addressing some low-hanging fruits

DOC: Fix ami_analyze description formatting

DOC: Fix ModelContainer ref and clean up devel_io_design formatting
@pllim @melanieclarke
Apply suggestions from melanieclarke
7d94086 
[ci skip]

Co-authored-by: Melanie Clarke <[email protected]>
@pllim @melanieclarke
Apply more suggestions from melanieclarke
4c49331 
[ci skip]

Co-authored-by: Melanie Clarke <[email protected]>
@pllim
DOC: Clean up skymatch doc
e9ecfb6 
and fix broken ref as pointed out by melanieclarke
@pllim
DOC: Address the rest of comments
2518059 
from melanieclarke.

DOC: Exorcise imgmath latex warning from local build. Just use what RTD uses.
@pllim
DOC: Fix ref to save method
3da107f
@pllim @melanieclarke
DOC: Fix more broken refs
57697bd 
Co-authored-by: Melanie Clarke <[email protected]>
@pllim
Copy link
Collaborator Author

pllim commented Aug 29, 2025

Hopefully good enough for now. To really go clean up the docstrings real good, might need to break down by subpackage or something, because ultimately a human has to read the docstring to be sure.

melanieclarke
melanieclarke approved these changes Aug 29, 2025
View reviewed changes
Copy link
Collaborator

@melanieclarke melanieclarke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, good enough for now! Thanks for all the fixes.

@melanieclarke melanieclarke enabled auto-merge (squash) August 29, 2025 19:18
@melanieclarke melanieclarke merged commit 328b4d3 into spacetelescope:main Aug 29, 2025
28 checks passed
@pllim pllim deleted the doc-ref-fixes-a branch August 29, 2025 22:02
@pllim pllim mentioned this pull request Sep 16, 2025
Merged
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@melanieclarke melanieclarke melanieclarke approved these changes

@zacharyburnett zacharyburnett zacharyburnett approved these changes

Assignees

No one assigned

Labels

ami assign_mtwcs assign_wcs associations combine_1d coron3 pipeline dark_current datamodels documentation extract_1d FGS fringe image3 pipeline master_background MIRI NIRCAM NIRISS NIRSPEC no-changelog-entry-needed outlier_detection path loss photom pipeline resample reset spec3 pipeline stpipe testing tweakreg wfs_combine wfss_contam Wide Field Slitless Spec (WFSS)

Projects

None yet

Milestone

Build 12.1

Development

Successfully merging this pull request may close these issues.

3 participants

@pllim @melanieclarke @zacharyburnett